<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />

	<title>Class ToolbarHelper</title>

	<script type="text/javascript" src="resources/combined.js?394153670"></script>
	<script type="text/javascript" src="elementlist.js?1800566221"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-abismo.html">abismo<span></span></a>
						<ul>
				<li><a href="package-abismo.admin.html">admin</a>
						</li>
				<li><a href="package-abismo.home.html">home</a>
						</li>
				<li><a href="package-abismo.images.html">images</a>
						</li>
				<li><a href="package-abismo.projects.html">projects</a>
						</li>
				<li><a href="package-abismo.Services.html">Services</a>
						</li>
				<li><a href="package-abismo.studio.html">studio</a>
						</li>
				<li><a href="package-abismo.tenders.html">tenders</a>
						</li>
				<li><a href="package-abismo.users.html">users</a>
						</li>
				<li><a href="package-abismo.videos.html">videos</a>
						</li>
				<li><a href="package-abismo.view.html">view<span></span></a>
						<ul>
				<li><a href="package-abismo.view.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li>
				<li class="active"><a href="package-app.html">app<span></span></a>
						<ul>
				<li><a href="package-app.Config.html">Config<span></span></a>
						<ul>
				<li><a href="package-app.Config.Schema.html">Schema</a>
						</li>
							</ul></li>
				<li><a href="package-app.Model.html">Model<span></span></a>
						<ul>
				<li><a href="package-app.Model.debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-app.Model.debug.kit.html">kit</a>
						</li>
							</ul></li></ul></li>
				<li class="active"><a href="package-app.View.html">View<span></span></a>
						<ul>
				<li class="active"><a href="package-app.View.Helper.html">Helper<span></span></a>
						<ul>
				<li class="active"><a href="package-app.View.Helper.debug.html">debug<span></span></a>
						<ul>
				<li class="active"><a href="package-app.View.Helper.debug.kit.html">kit<span></span></a>
						<ul>
				<li class="active"><a href="package-app.View.Helper.debug.kit.views.html">views<span></span></a>
						<ul>
				<li class="active"><a href="package-app.View.Helper.debug.kit.views.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li></ul></li></ul></li></ul></li></ul></li>
				<li><a href="package-cake.html">cake<span></span></a>
						<ul>
				<li><a href="package-cake.debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-cake.debug.kit.html">kit<span></span></a>
						<ul>
				<li><a href="package-cake.debug.kit.panels.html">panels</a>
						</li>
							</ul></li></ul></li></ul></li>
				<li><a href="package-debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-debug.kit.html">kit<span></span></a>
						<ul>
				<li><a href="package-debug.kit.components.html">components</a>
						</li>
				<li><a href="package-debug.kit.controllers.html">controllers<span></span></a>
						<ul>
				<li><a href="package-debug.kit.controllers.components.html">components</a>
						</li>
							</ul></li>
				<li><a href="package-debug.kit.Lib.html">Lib</a>
						</li>
				<li><a href="package-debug.kit.models.html">models<span></span></a>
						<ul>
				<li><a href="package-debug.kit.models.behaviors.html">behaviors</a>
						</li>
							</ul></li>
				<li><a href="package-debug.kit.vendors.html">vendors</a>
						</li>
				<li><a href="package-debug.kit.views.html">views<span></span></a>
						<ul>
				<li><a href="package-debug.kit.views.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li></ul></li>
				<li><a href="package-localized.html">localized</a>
						</li>
				<li><a href="package-Localized.html">Localized<span></span></a>
						<ul>
				<li><a href="package-localized.tests.html">tests<span></span></a>
						<ul>
				<li><a href="package-localized.tests.cases.html">cases<span></span></a>
						<ul>
				<li><a href="package-localized.tests.cases.libs.html">libs</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-Localized.Validation.html">Validation</a>
						</li>
							</ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-FirePhpToolbarHelper.html">FirePhpToolbarHelper</a></li>
				<li><a href="class-HtmlToolbarHelper.html">HtmlToolbarHelper</a></li>
				<li><a href="class-SimpleGraphHelper.html">SimpleGraphHelper</a></li>
				<li class="active"><a href="class-ToolbarHelper.html">ToolbarHelper</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-app.View.Helper.debug.kit.views.helpers.html" title="Summary of app\View\Helper\debug\kit\views\helpers"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class ToolbarHelper</h1>


	<div class="description">
	
<p>Application helper</p>

<p>Add your application-wide methods in the class below, your helpers will
inherit them.</p>

	</div>

	<dl class="tree">
		<dd style="padding-left:0px">
Helper
			
			
		</dd>
		<dd style="padding-left:30px">
			<img src="resources/inherit.png" alt="Extended by" />
			<a href="class-AppHelper.html"><span>AppHelper</span></a>
			
			
			
		</dd>
		<dd style="padding-left:60px">
			<img src="resources/inherit.png" alt="Extended by" />
<b><span>ToolbarHelper</span></b>			
			
			
		</dd>
	</dl>


	<div>
		<h4>Direct known subclasses</h4>
			<a href="class-FirePhpToolbarHelper.html">FirePhpToolbarHelper</a>, 
			<a href="class-HtmlToolbarHelper.html">HtmlToolbarHelper</a>
	</div>






	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-app.html">app</a>\<a href="package-app.View.html">View</a>\<a href="package-app.View.Helper.html">Helper</a>\<a href="package-app.View.Helper.debug.html">debug</a>\<a href="package-app.View.Helper.debug.kit.html">kit</a>\<a href="package-app.View.Helper.debug.kit.views.html">views</a>\<a href="package-app.View.Helper.debug.kit.views.helpers.html">helpers</a><br />

				<b>Copyright:</b>
				Copyright 2005-2010, Cake Software Foundation, Inc. (<a
href="http://cakefoundation.org">http://cakefoundation.org</a>)<br />
				<b>License:</b>
				<a href="MIT">License (http://www.opensource.org/licenses/mit-license.php)</a><br />
		<b>Located at</b> <a href="source-class-ToolbarHelper.html#25-208" title="Go to source code">Plugin/DebugKit/View/Helper/ToolbarHelper.php</a><br />
	</div>



	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="__construct" id="___construct">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___construct">#</a>
		<code><a href="source-class-ToolbarHelper.html#41-72" title="Go to source code">__construct</a>( <span>string <var>$View</var></span>, <span>mixed <var>$options</var> = <span class="php-keyword1">array</span>()</span> )</code>

		<div class="description short">
			
<p>Construct the helper and make the backend helper.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Construct the helper and make the backend helper.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$View</var></dt>
					<dd><code>string</code><br>$options</dd>
					<dt><var>$options</var></dt>
					<dd></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="afterLayout" id="_afterLayout">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_afterLayout">#</a>
		<code><a href="source-class-ToolbarHelper.html#74-84" title="Go to source code">afterLayout</a>( <span>string <var>$layoutFile</var></span> )</code>

		<div class="description short">
			
<p>afterLayout callback</p>

		</div>

		<div class="description detailed hidden">
			
<p>afterLayout callback</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$layoutFile</var></dt>
					<dd><code>string</code><br>$layoutFile</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="getName" id="_getName">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getName">#</a>
		<code><a href="source-class-ToolbarHelper.html#86-94" title="Go to source code">getName</a>( )</code>

		<div class="description short">
			
<p>Get the name of the backend Helper used to conditionally trigger toolbar
output</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get the name of the backend Helper used to conditionally trigger toolbar
output</p>




				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="__call" id="___call">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___call">#</a>
		<code><a href="source-class-ToolbarHelper.html#96-109" title="Go to source code">__call</a>( <span>string <var>$method</var></span>, <span>mixed <var>$params</var></span> )</code>

		<div class="description short">
			
<p>call__</p>

		</div>

		<div class="description detailed hidden">
			
<p>call__</p>

<p>Allows method calls on backend helper</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$method</var></dt>
					<dd><code>string</code><br>$method</dd>
					<dt><var>$params</var></dt>
					<dd><code>mixed</code><br>$params</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="writeCache" id="_writeCache">

		<td class="attributes"><code>
			 public 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_writeCache">#</a>
		<code><a href="source-class-ToolbarHelper.html#111-128" title="Go to source code">writeCache</a>( <span>string <var>$name</var></span>, <span>string <var>$content</var></span> )</code>

		<div class="description short">
			
<p>Allows for writing to panel cache from view. Some panels generate all
variables in the view by necessity ie. Timer. Using this method, will allow you
to replace in full the content for a panel.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Allows for writing to panel cache from view. Some panels generate all
variables in the view by necessity ie. Timer. Using this method, will allow you
to replace in full the content for a panel.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$name</var></dt>
					<dd><code>string</code><br>$name Name of the panel you are replacing.</dd>
					<dt><var>$content</var></dt>
					<dd><code>string</code><br>$content Content to write to the panel.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br>Sucess of write.<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="readCache" id="_readCache">

		<td class="attributes"><code>
			 public 
			mixed
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_readCache">#</a>
		<code><a href="source-class-ToolbarHelper.html#130-145" title="Go to source code">readCache</a>( <span>string <var>$name</var></span>, <span>mixed <var>$index</var> = <span class="php-num">0</span></span> )</code>

		<div class="description short">
			
<p>Read the toolbar</p>

		</div>

		<div class="description detailed hidden">
			
<p>Read the toolbar</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$name</var></dt>
					<dd><code>string</code><br>$name Name of the panel you want cached data for</dd>
					<dt><var>$index</var></dt>
					<dd></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>mixed</code><br>Boolean false on failure, array of data otherwise.<br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getQueryLogs" id="_getQueryLogs">

		<td class="attributes"><code>
			 public 
			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getQueryLogs">#</a>
		<code><a href="source-class-ToolbarHelper.html#147-207" title="Go to source code">getQueryLogs</a>( <span>string <var>$connection</var></span>, <span>array <var>$options</var> = <span class="php-keyword1">array</span>()</span> )</code>

		<div class="description short">
			
<p>Gets the query logs for the given connection names.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Gets the query logs for the given connection names.</p>

<h1>Options</h1>

<ul>
	<li>explain - Whether explain links should be generated for this
	connection.</li>

	<li>cache - Whether the toolbar_state Cache should be updated.</li>

	<li>threshold - The threshold at which a visual 'maybe slow' flag should be
	added. results with rows/ms lower than $threshold will be marked.</li>
</ul>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$connection</var></dt>
					<dd><code>string</code><br>$connection Connection name to get logs for.</dd>
					<dt><var>$options</var></dt>
					<dd><code>array</code><br>$options Options for the query log retrieval.</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>array</code><br>Array of data to be converted into a table.<br />
				</div>




		</div>
		</div></td>
	</tr>
	</table>












	<table class="summary" id="properties">
	<caption>Properties summary</caption>
	<tr data-order="settings" id="$settings">
		<td class="attributes"><code>
			public  
			array
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarHelper.html#27-32" title="Go to source code"><var>$settings</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">array</span>()</code></td>
		<td class="description"><div>
			<a href="#$settings" class="anchor">#</a>

			<div class="description short">
				
<p>settings property to be overloaded. Subclasses should specify a format</p>

			</div>

			<div class="description detailed hidden">
				
<p>settings property to be overloaded. Subclasses should specify a format</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="_cacheEnabled" id="$_cacheEnabled">
		<td class="attributes"><code>
			protected  
			boolean
		</code></td>

		<td class="name">
				<a href="source-class-ToolbarHelper.html#34-39" title="Go to source code"><var>$_cacheEnabled</var></a>
		</td>
		<td class="value"><code><span class="php-keyword1">false</span></code></td>
		<td class="description"><div>
			<a href="#$_cacheEnabled" class="anchor">#</a>

			<div class="description short">
				
<p>flag for whether or not cache is enabled.</p>

			</div>

			<div class="description detailed hidden">
				
<p>flag for whether or not cache is enabled.</p>


			</div>
		</div></td>
	</tr>
	</table>






</div>

	<div id="footer">
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
